Scripting > CxEditors > CxAudEditor Object > CxAudEditor Methods

CxAudEditor Methods

The CxAudEditor object contains the following methods:

Configure

The Configure method launches an Audit Service Definitions dialog box which is used to configure AUD attributes.

Syntax

Configure() As Integer

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

Close or Save button was pressed.

Example

The following example launches an Audit Service Definitions dialog box.

Sub

Dim iRet

iRet = AudEditor.Configure

MsgBox iRet

End Sub

Back to top

Connect

The Connect method connects to a AUD.

Syntax

Connect(DomainSiteService As String)

Parameters

Parameter Required Description

DomainSiteService

Yes

The [Domain]Site.Service to which to connect. A domain is optional. The service must be a valid AUD.

Example

The following example creates and connects the CxAudEditor object.

Sub

Dim AudEditor

Set AudEditor = CreateObject("CxEditors.CxAudEditor")

AudEditor.Connect("[5410]CYGDEMO.AUD")

End Sub

Back to top

Copy

This method is unimplemented.

Back to top

Delete

This method is unimplemented.

Back to top

Disconnect

The Disconnect method disconnects from the connected AUD service.

Syntax

Disconnect()

Example

The following example disconnects the AudEditor object.

Sub

AudEditor.Disconnect

End Sub

Back to top

Edit

The Edit method launches an Audit Trail Transaction Properties dialog box for the specified record.

Syntax

Edit(QueueKey As String) As Integer

Parameters

Parameter Required Description

QueueKey

Yes

The database queue key of the record to edit.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

OK button was pressed.
  2 Cancel button was pressed.

Example

The following example launches an Audit Trail Transaction Properties dialog box for record "0000000001."

Sub

Dim iRet

iRet = AudEditor.Edit("0000000001")

 

MsgBox iRet

End Sub

Back to top

New

The New method launches a Create New Audit Trail Transaction dialog box.

Syntax

New() As Integer

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

OK button was pressed.
  2 Cancel button was pressed.

Example

The following example launches a Create New Audit Trail Transaction dialog box.

Sub

Dim iRet

iRet = AudEditor.New

 

MsgBox iRet

End Sub

Back to top

View

The View method launches an Audit Trail Transaction Properties dialog box for the specified record.

Syntax

View(Key As String, EditEnabled As Boolean) As Integer

Parameters

Parameter Required Description

Key

Yes

The database queue key of the record to view/edit.

EditEnabled

Yes

Set this parameter to true to enable editing of a record.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

OK button was pressed.
  2 Cancel button was pressed.

Example

The following example launches an Audit Trail Transaction Properties dialog box for record "0000000001."

Sub

Dim iRet

iRet = AudEditor.View("0000000001", True)

MsgBox iRet

End Sub

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.